I3DShTimeBasedData Struct Reference
[Shell Interfaces]

Inheritance diagram for I3DShTimeBasedData:

IMCUnknown List of all members.

Public Member Functions

virtual void MCCOMAPI SetTimeBased (ITimeBased *inTimeBased)=0
virtual ITimeBased *MCCOMAPI GetTimeBasedNoAddRef ()=0
virtual MCCOMErr MCCOMAPI GetTimeBased (ITimeBased **outTimeBased)=0
virtual void MCCOMAPI SetValidForCurrentTime ()=0
virtual MCCOMErr MCCOMAPI MarkParamAsModified (int32 index)=0
virtual boolean MCCOMAPI CheckParamForRead (int32 index)=0
virtual void MCCOMAPI SetApproximateParamCount (uint32 Count)=0
virtual int32 MCCOMAPI SetParam (void *aparam, const int8 *itsName, IDType itsID, IDType itsType, int8 graphColorIndex=-1)=0
virtual int32 MCCOMAPI SetParamGroup (ITimeBased *aGroup, const int8 *itsName, IDType itsID)=0
virtual MCCOMErr MCCOMAPI RemoveParams (const int32 index, const int32 count)=0
virtual MCCOMErr MCCOMAPI ClearParams ()=0
virtual MCCOMErr MCCOMAPI EnableParam (int32 index, boolean enable)=0
virtual MCCOMErr MCCOMAPI ChangeParamGroup (ITimeBased *aGroup, int32 index)=0
virtual MCCOMErr MCCOMAPI CopyData (I3DShTimeBasedData *dest)=0
virtual boolean MCCOMAPI IsAnimated () const =0
virtual void MCCOMAPI SetAnimated (boolean animated)=0
virtual void MCCOMAPI SetTimeManager (I3DShTimeManager *timeManager)=0
virtual void MCCOMAPI GetTimeManager (I3DShTimeManager **)=0
virtual void MCCOMAPI GetTweener (I3DShTweener **tweener, int32 time, int32 index) const =0
virtual void MCCOMAPI SetTweener (int32 time, int32 index, I3DShTweener *atweener)=0
virtual boolean MCCOMAPI IsTimeLineExpanded () const =0
virtual void MCCOMAPI SetTimeLineExpanded (boolean isExpanded)=0
virtual TMCPoint MCCOMAPI GetDrawOrigin ()=0
virtual void MCCOMAPI SetDrawOrigin (TMCPoint &origin)=0
virtual int32 MCCOMAPI GetParamHeight ()=0
virtual void MCCOMAPI SetParamHeight (int32 inParamHeight)=0
virtual int32 MCCOMAPI GetSonsCount () const =0
virtual MCCOMErr MCCOMAPI GetSonByIndex (ITimeBased **result, int32 index, IDType &itsType, IDType &itsID, boolean &isGroup, boolean &isEnabled, int8 *itsName) const =0
virtual void MCCOMAPI GetFather (I3DShTimeBasedData **parent) const =0
virtual int32 MCCOMAPI GetParamInfoCount () const =0
virtual void MCCOMAPI GetParamInfoByIndex (I3DShParamInfo **paramInfo, int32 index) const =0
virtual void MCCOMAPI GetParamInfoByID (I3DShParamInfo **paramInfo, IDType id) const =0
virtual int32 MCCOMAPI FindParamInfoIndex (IDType id) const =0
virtual IDType MCCOMAPI GetType () const =0
virtual void MCCOMAPI SetType (IDType type, const int8 *className)=0
virtual MicroTick MCCOMAPI GetTime () const =0
virtual void MCCOMAPI SetLocalTime (MicroTick inTime)=0
virtual const int8 *MCCOMAPI GetClassName ()=0
virtual void MCCOMAPI GetMergedTimeLine (I3DShParamTimeLine **timeline)=0
virtual MCCOMErr MCCOMAPI ForEachTimeLine (IForEachTimeLineCallback *callback)=0
virtual MCCOMErr MCCOMAPI InvalidateTimeLine ()=0
virtual MCCOMErr MCCOMAPI InvalidateFathersTime ()=0
virtual MCCOMErr MCCOMAPI InvalidateMerged ()=0

Detailed Description

The TimeBased Data is the object that stores the animation parameters of a timebased object.

Member Function Documentation

virtual MCCOMErr MCCOMAPI I3DShTimeBasedData::ChangeParamGroup (  ITimeBased *  aGroup,
int32  index
)  [pure virtual]
 

Change a param group (see SetParamGroup()).

Parameters:
aGroup The new timebased.
index The index of the parameter.

virtual boolean MCCOMAPI I3DShTimeBasedData::CheckParamForRead (  int32  index  )  [pure virtual]
 

Should be called before accessing the value of an animated parameter.

Parameters:
index The index of the parameter.

virtual MCCOMErr MCCOMAPI I3DShTimeBasedData::ClearParams (   )  [pure virtual]
 

Removes all the parameters.

virtual MCCOMErr MCCOMAPI I3DShTimeBasedData::CopyData (  I3DShTimeBasedData *  dest  )  [pure virtual]
 

Copy the data of this time based data into another one.

Parameters:
dest The destination time based data.

virtual MCCOMErr MCCOMAPI I3DShTimeBasedData::EnableParam (  int32  index,
boolean  enable
)  [pure virtual]
 

Enable/Disable a parameter.

Parameters:
index The index of the parameter.
enable the state of the parameter.

virtual int32 MCCOMAPI I3DShTimeBasedData::FindParamInfoIndex (  IDType  id  )  const [pure virtual]
 

Returns the index of the parameter with a certain ID or -1 if not found.

Parameters:
id The ID of the parameter.

virtual MCCOMErr MCCOMAPI I3DShTimeBasedData::ForEachTimeLine (  IForEachTimeLineCallback *  callback  )  [pure virtual]
 

Calls a callback for each of the timeline of the parameters.

Parameters:
callback The callback function.

virtual const int8* MCCOMAPI I3DShTimeBasedData::GetClassName (   )  [pure virtual]
 

Returns the classname of the timebased data.

virtual TMCPoint MCCOMAPI I3DShTimeBasedData::GetDrawOrigin (   )  [pure virtual]
 

Internal use only.

virtual void MCCOMAPI I3DShTimeBasedData::GetFather (  I3DShTimeBasedData **  parent  )  const [pure virtual]
 

Returns the parent of the timebased.

Parameters:
parent A pointer to the parent.

virtual void MCCOMAPI I3DShTimeBasedData::GetMergedTimeLine (  I3DShParamTimeLine **  timeline  )  [pure virtual]
 

Returns the merged time line that corresponds to this timebased data. This is the time line that sums up all the timelines of all the parameters.

Parameters:
timeline A pointer to the timeline that is returned.

virtual int32 MCCOMAPI I3DShTimeBasedData::GetParamHeight (   )  [pure virtual]
 

Internal use only.

virtual void MCCOMAPI I3DShTimeBasedData::GetParamInfoByID (  I3DShParamInfo **  paramInfo,
IDType  id
)  const [pure virtual]
 

Returns a pointer to a parameter with a certain ID.

Parameters:
paramInfo A pointer to the parameter information.
id The ID of the parameter.

virtual void MCCOMAPI I3DShTimeBasedData::GetParamInfoByIndex (  I3DShParamInfo **  paramInfo,
int32  index
)  const [pure virtual]
 

Returns a pointer to a parameter indentified by its index.

Parameters:
paramInfo A pointer to the parameter information.
index The index of the parameter.

virtual int32 MCCOMAPI I3DShTimeBasedData::GetParamInfoCount (   )  const [pure virtual]
 

Returns the number of paramaters.

virtual MCCOMErr MCCOMAPI I3DShTimeBasedData::GetSonByIndex (  ITimeBased **  result,
int32  index,
IDType &  itsType,
IDType &  itsID,
boolean &  isGroup,
boolean &  isEnabled,
int8 *  itsName
)  const [pure virtual]
 

Returns a pointer to one of the children of this timebased.

Parameters:
result A pointer to the child
index The index of the parameter.
itsType The type of the parameter
itsID The ID of the child
isGroup True if this is a group.
isEnabled True if it is enabled.
itsName The name of the parameter.

virtual int32 MCCOMAPI I3DShTimeBasedData::GetSonsCount (   )  const [pure virtual]
 

Returns the number of timebased that are children of this timebased.

virtual MicroTick MCCOMAPI I3DShTimeBasedData::GetTime (   )  const [pure virtual]
 

Returns the time of the last update of the timebased data.

virtual MCCOMErr MCCOMAPI I3DShTimeBasedData::GetTimeBased (  ITimeBased **  outTimeBased  )  [pure virtual]
 

Returns a pointer to the timebased that owns this timebased data.

Parameters:
outTimeBased 

virtual ITimeBased* MCCOMAPI I3DShTimeBasedData::GetTimeBasedNoAddRef (   )  [pure virtual]
 

Returns a pointer to the timebased that owns this timebased data.

virtual void MCCOMAPI I3DShTimeBasedData::GetTimeManager (  I3DShTimeManager **   )  [pure virtual]
 

Returns the timemanager (usually it is the time manager of the scene).

virtual void MCCOMAPI I3DShTimeBasedData::GetTweener (  I3DShTweener **  tweener,
int32  time,
int32  index
)  const [pure virtual]
 

Returns a pointer to the tweener that interpolates a particular parameter at a given time.

Parameters:
tweener The tweener that is returned.
time The time considered.
index The index of the parameter.

virtual IDType MCCOMAPI I3DShTimeBasedData::GetType (   )  const [pure virtual]
 

Returns the type of the timebased data.

virtual MCCOMErr MCCOMAPI I3DShTimeBasedData::InvalidateFathersTime (   )  [pure virtual]
 

Invalidate the time of the parents.

virtual MCCOMErr MCCOMAPI I3DShTimeBasedData::InvalidateMerged (   )  [pure virtual]
 

Invalidates the merge time line.

virtual MCCOMErr MCCOMAPI I3DShTimeBasedData::InvalidateTimeLine (   )  [pure virtual]
 

Invalidates the time line.

virtual boolean MCCOMAPI I3DShTimeBasedData::IsAnimated (   )  const [pure virtual]
 

Returns true if animation is enabled.

virtual boolean MCCOMAPI I3DShTimeBasedData::IsTimeLineExpanded (   )  const [pure virtual]
 

Internal use only.

virtual MCCOMErr MCCOMAPI I3DShTimeBasedData::MarkParamAsModified (  int32  index  )  [pure virtual]
 

Mark a parameter as invalid. Cause CheckParamForRead to be called.

Parameters:
index The index of the parameter.

virtual MCCOMErr MCCOMAPI I3DShTimeBasedData::RemoveParams (  const int32  index,
const int32  count
)  [pure virtual]
 

Parameters:
index The index of the first parameter to remove
count The number of parameter to remove.

virtual void MCCOMAPI I3DShTimeBasedData::SetAnimated (  boolean  animated  )  [pure virtual]
 

Sets the animation of the timebaseddata.

Parameters:
animated the animation state.

virtual void MCCOMAPI I3DShTimeBasedData::SetApproximateParamCount (  uint32  Count  )  [pure virtual]
 

Allow faster allocation of the array of parameters.

Parameters:
Count Estimated number of parameters.

virtual void MCCOMAPI I3DShTimeBasedData::SetDrawOrigin (  TMCPoint &  origin  )  [pure virtual]
 

Internal use only.

virtual void MCCOMAPI I3DShTimeBasedData::SetLocalTime (  MicroTick  inTime  )  [pure virtual]
 

Set a local time to this param, when read it won't use the scene time but this local time Set local time to kInvalidTime to use the scene time back.

Parameters:
inTime The new local time or kInvalidTime

virtual int32 MCCOMAPI I3DShTimeBasedData::SetParam (  void *  aparam,
const int8 *  itsName,
IDType  itsID,
IDType  itsType,
int8  graphColorIndex = -1
)  [pure virtual]
 

Adds a new parameter.

Parameters:
aparam A pointer to the value of the parameter. (the paramater keeps a reference to this address so it should be be deleted until the timebased is destroyed)
itsName The name of the parameter.
itsID The ID of the parameter (as displayed in the UI).
itsType The type of the parameter.
graphColorIndex The index of the color to be used in the graph editor (-1 means default color).

virtual int32 MCCOMAPI I3DShTimeBasedData::SetParamGroup (  ITimeBased *  aGroup,
const int8 *  itsName,
IDType  itsID
)  [pure virtual]
 

Adds a new parameter group.

Parameters:
aGroup A pointer to the timebased that contains the sub parameters.
itsName The name of the parameter (as displayed in the UI).
itsID The ID of the parameter.

virtual void MCCOMAPI I3DShTimeBasedData::SetParamHeight (  int32  inParamHeight  )  [pure virtual]
 

Internal use only.

Parameters:
inParamHeight 

virtual void MCCOMAPI I3DShTimeBasedData::SetTimeBased (  ITimeBased *  inTimeBased  )  [pure virtual]
 

Sets the timebased that owns this timebased data.

Parameters:
inTimeBased A pointer to the timebased.

virtual void MCCOMAPI I3DShTimeBasedData::SetTimeLineExpanded (  boolean  isExpanded  )  [pure virtual]
 

Internal use only.

virtual void MCCOMAPI I3DShTimeBasedData::SetTimeManager (  I3DShTimeManager *  timeManager  )  [pure virtual]
 

Sets the timemanager (usually it is the time manager of the scene).

Parameters:
timeManager A pointer to the time manager.

virtual void MCCOMAPI I3DShTimeBasedData::SetTweener (  int32  time,
int32  index,
I3DShTweener *  atweener
)  [pure virtual]
 

Sets the tweener that interpolates a particular parameter at a given time.

Parameters:
time The time considered.
index The index of the parameter.
atweener The tweener

virtual void MCCOMAPI I3DShTimeBasedData::SetType (  IDType  type,
const int8 *  className
)  [pure virtual]
 

Sets the type of the timebased data.

Parameters:
type The type.
className Name of the class.

virtual void MCCOMAPI I3DShTimeBasedData::SetValidForCurrentTime (   )  [pure virtual]
 

Mark as valid for current time.

The documentation for this struct was generated from the following file:
Generated on Wed Dec 7 14:27:35 2005 for Carrara SDK Doc by  doxygen 1.4.5